From 45d6eb6f4f0c24082b8b9cbf4b54e606ebd2832e Mon Sep 17 00:00:00 2001 From: Justin Burkett Date: Sun, 19 Jul 2015 23:37:17 -0400 Subject: [PATCH] Update README.org --- README.org | 11 ++++++++++- 1 file changed, 10 insertions(+), 1 deletion(-) diff --git a/README.org b/README.org index 810deff70cb..fa85454185a 100644 --- a/README.org +++ b/README.org @@ -1,7 +1,16 @@ * which-key [[http://melpa.org/#/which-key][http://melpa.org/packages/which-key-badge.svg]] ** Introduction -This is a rewrite of [[https://github.com/kai2nenobu/guide-key][guide-key-mode]] for emacs. The intention is to provide the +=which-key= is a minor mode for Emacs that displays the keybindings following your currently +entered incomplete command (a prefix) in a popup. For example, after enabling the minor mode +if you enter =C-x= and wait for the default of 1 second the minibuffer will expand with all of +the available keybindings that follow =C-x= (or as many as space allows given your settings). +This includes prefixes like =C-x 8= which are shown in a different face. Screenshots of what +the popup will look like are included below. =which-key= started as a rewrite of +[[https://github.com/kai2nenobu/guide-key][guide-key-mode]], but the feature sets have diverged +to a certain extent. + +With respect to =guide-key=, the intention is to provide the following features: 1. A different polling mechanism to make it lighter on resources than guide-key 2. An improved display of keys with more keys being shown by default and a nicer -- 2.30.2